Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: js release yml, reduce batch size, change telemetry payload #975

Merged
merged 11 commits into from
Dec 11, 2024

Conversation

himanshu-dixit
Copy link
Collaborator

@himanshu-dixit himanshu-dixit commented Dec 10, 2024

  • Remove manual update, facing permission issues

Important

Fix permission issues in GitHub Actions, update versioning, improve error handling, and enhance telemetry in the JS SDK.

  • GitHub Actions:
    • Add contents: write permission to release_js_sdk.yml to resolve permission issues.
    • Remove manual version update and commit steps from release_js_sdk.yml.
  • Version Updates:
    • Update version in package.json from 0.3.2 to 0.4.1-beta.
    • Update COMPOSIO_VERSION in constants.js from 0.3.0 to 0.4.1-beta.
  • Error Handling:
    • Change error code in error.ts from SDK_ERROR_CODES.COMMON.UNKNOWN to SDK_ERROR_CODES.BACKEND.SERVER_UNREACHABLE for unreachable server errors.
    • Add SERVER_UNREACHABLE to SDK_ERROR_CODES in constants.ts.
  • Telemetry:
    • Reduce batch size in telemetry/index.ts from 1000 to 10.
    • Add more metadata fields to telemetry payload in telemetry/index.ts.

This description was created by Ellipsis for 4cdbf89. It will automatically update as commits are pushed.

Copy link

vercel bot commented Dec 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
composio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 6:06am

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 6ca47e3 in 9 seconds

More details
  • Looked at 62 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. .github/workflows/release_js_sdk.yml:40
  • Draft comment:
    The removal of the version update and commit steps means the version in package.json and constants.js must be manually updated before running this workflow. Ensure this is done to avoid publishing with an incorrect version.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The removal of the version update and commit steps in the workflow is intentional to avoid permission issues. However, this means the version in package.json and constants.js must be manually updated before running the workflow.

Workflow ID: wflow_Tme0Y6S8ktpeIAQu


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@@ -14,6 +14,8 @@ on:

jobs:
run-js-tests:
permissions:
contents: write
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a comment explaining why write permissions are needed here. This helps future maintainers understand the security implications and requirements.

@@ -8,7 +8,7 @@ const ACTIONS = {
// actions list end here
};

const COMPOSIO_VERSION = `0.3.0`;
const COMPOSIO_VERSION = `0.4.0-beta`;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to see version alignment between package.json and constants.js. Consider implementing a single source of truth for version numbers to prevent future mismatches. This could be done through a version management script or using package.json as the primary source.

@shreysingla11
Copy link
Collaborator

Review Summary

Changes Overview

  • Added write permissions to workflow
  • Removed git commit steps from workflow
  • Aligned version numbers across files to 0.4.0-beta
  • Simplified release process

Positive Aspects

✅ Version alignment between package.json and constants.js
✅ Addition of explicit permissions in workflow
✅ Simplified release process

Suggestions

  1. Add comments in workflow file explaining permission requirements
  2. Consider implementing a single source of truth for version numbers
  3. Document the new release process for future reference

Overall Assessment

The changes improve the release process and fix version inconsistencies. The code quality is good, and the changes are focused and purposeful. Approved with minor suggestions for documentation improvements.

Copy link

github-actions bot commented Dec 10, 2024

This comment was generated by github-actions[bot]!

JS SDK Coverage Report

📊 Coverage report for JS SDK can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/coverage-12270664567/coverage/index.html

📁 Test report folder can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/html-report-12270664567/html-report/report.html

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on 0f84c29 in 18 seconds

More details
  • Looked at 77 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. js/src/sdk/utils/telemetry/index.ts:10
  • Draft comment:
    Reducing the batch size from 100 to 10 may increase the number of requests sent, potentially affecting performance. Ensure this change is intentional.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The batch size in the BatchProcessor has been reduced from 100 to 10. This change might affect performance by increasing the number of requests sent. It's important to ensure this change is intentional and justified.
2. js/src/sdk/utils/error.ts:111
  • Draft comment:
    The error message for ETIMEDOUT should not mention ECONNABORTED. Consider updating the message to reflect the correct error code.
  • Reason this comment was not posted:
    Comment was not on a valid diff hunk.

Workflow ID: wflow_qh541wfbqExbNhsw


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on 75f1f43 in 9 seconds

More details
  • Looked at 36 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. js/src/sdk/utils/telemetry/index.ts:8
  • Draft comment:
    The batch size in the BatchProcessor constructor is set to 100, but the PR description mentions reducing it to 10. Please update the batch size to 10 to match the PR description.
  • Reason this comment was not posted:
    Comment did not seem useful.

Workflow ID: wflow_Wqf5qyJi5YyyV8KS


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on f9512c2 in 10 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_71dHR61YVFaBOVEV


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on ff5ae3b in 25 seconds

More details
  • Looked at 94 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. js/src/sdk/utils/error.ts:90
  • Draft comment:
    The error message uses ECONNABORTED while the error code is ETIMEDOUT. Consider updating the error message to reflect the correct error code.
        `Request to ${fullUrl} timed out after the configured timeout period. This could be due to slow network conditions, server performance issues, or the request being too large. Error code: ECONNABORTED`,
  • Reason this comment was not posted:
    Comment looked like it was already resolved.

Workflow ID: wflow_7YERFJJ1ZOelhMb1


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@himanshu-dixit himanshu-dixit changed the title fix: js release yml fix: js release yml, reduce batch size, change telemetry payload Dec 11, 2024
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on 063b382 in 40 seconds

More details
  • Looked at 26 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. js/package.json:3
  • Draft comment:
    The version update in package.json to 0.4.1-beta is inconsistent with the PR description, which mentions 0.4.0-beta. Please ensure the version is consistent across the PR.
  • Reason this comment was not posted:
    Comment did not seem useful.
2. js/src/constants.js:11
  • Draft comment:
    The version update in constants.js to 0.4.1-beta is inconsistent with the PR description, which mentions 0.4.0-beta. Please ensure the version is consistent across the PR.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_Ud4epnN1B8wnNKDY


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on 4cdbf89 in 30 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. js/src/frameworks/langchain.spec.ts:72
  • Draft comment:
    Typo in property name: successfull should be successful. This typo is present in the expect statement.
  • Reason this comment was not posted:
    Comment was on unchanged code.

Workflow ID: wflow_pUSGqjgThGfubqbs


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@himanshu-dixit himanshu-dixit merged commit d7b9502 into master Dec 11, 2024
14 checks passed
@himanshu-dixit himanshu-dixit deleted the ft-js-release branch December 11, 2024 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants